Appointment Management API - TMF646
API Data Dictionary - Repair - POST searchTimeSlot
API Request Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| appointmentType |
Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| category | Repair | Extension to the API. It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| requestedTimeslot | See requestedTimeslot table | array |
| relatedParty | See relatedParty table | array |
| relatedEntity | See relatedEntity table |
array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product |
| @type | PXCSearchTimeSlot | |
| @baseType | SearchTimeSlot |
API Response Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| searchDate | 2025-02-01T14:48:45.071Z | Timestamp of when the searchTimeslot request was performed. |
| searchResult | success | Result of the searchTimeslot. Will be set to success. |
| category | Repair | Extension to the API. It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| requestedTimeslot | See requestedTimeslot table | array |
| relatedEntity | See relatedEntity table |
array for AccessCASR contains a AccessCASR and the BillingAccount elements id = <an AccessCASR> role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = <a ProductId> role = relatedProduct @referredType = Product |
| availableTimeslot | See availableTimeslot table | array |
| status | done | Status of the searchTimeslot. Will be set to done. |
| @type | PXCSearchTimeSlot | |
| @baseType | SearchTimeSlot |